home *** CD-ROM | disk | FTP | other *** search
/ Amiga Plus 1995 #3 & #4 / Amiga Plus CD - 1995 - No. 3 and 4.iso / pd / sonstiges / translator / docs / translator.autodoc next >
Text File  |  1995-07-20  |  4KB  |  130 lines
  1.  
  2.  
  3. TABLE OF CONTENTS
  4.  
  5. translator.library/--background--
  6. translator.library/Translate
  7. translator.library/TranslateAs
  8. translator.library/SetAccent
  9. translator.library/LoadAccent
  10.  
  11. translator.library/--background--           translator.library/--background--
  12.  
  13.     OVERVIEW
  14.     Version 42 of the translator library supports multi-lingual
  15.     text to phoneme translation. It maintains a list of loaded
  16.     accent files. The user can select the accent with the Translator
  17.     preferences program.
  18.  
  19.     COMPATIBILITY
  20.     Great care has been taken to ensure the new library works in
  21.     all situations where the old one did. Because the new library
  22.     has more to do, it is more likely somthing will go wrong.
  23.     The old Translate() interface did not provide sufficient
  24.     room for expansion. In this version errors are reported
  25.     to the user by means of a requester. This includes reporting
  26.     syntax errors in the Accent files.
  27.     Functions in this library may be called from tasks even
  28.     if they might cause DOS I/O.
  29.     
  30.     The library creates a new base for each call to OpenLibrary.    
  31.     However the list of loaded accents is global to all library bases.
  32.  
  33. translator.library/Translate                       translator.library/Translate
  34.  
  35.     NAME
  36.     Translate -- Convert an text string into narrator device phonemes.
  37.  
  38.     SYNOPSIS
  39.     rtnCode = Translate(inString, inLength, outBuffer, outLength)
  40.     D0                  A0        D0        A1         D1
  41.  
  42.     LONG Translate( STRPTR inString, LONG inLength, STRPTR outBuffer,
  43.         LONG outlen );
  44.  
  45.     FUNCTION
  46.     The translate function converts a text string into
  47.     a string of phonetic codes suitable as input to the
  48.     narrator device. The V42 version may need to call the DOS
  49.     library. If called by a task it will start a process to do
  50.     the I/O. The origional version allocated no external resources
  51.     including memory or other shared libraries. The new version
  52.     allocate memory and may call Exec and DOS functions. Thus
  53.     there is the possibility of these calls failing. However the
  54.     privious version was documented so:
  55.     
  56.         The only error that can occur is overflowing the outBuffer.
  57.     
  58.     For this reason no error code can be returned. If an error
  59.     occurs a message is displayed in a requester or to the console
  60.     and 0 is returned. The output buffer set to an empty string.
  61.     
  62.     INPUTS
  63.     inString - pointer to English string
  64.     inLength - length of English string
  65.     outBuffer - a char array which will hold the phonetic codes
  66.     outLength - the length of the output array
  67.  
  68.     RESULTS
  69.     rtnCode - zero if no error has occured.
  70.     The only error that can occur (as far as the calling process
  71.         need be concerned) is overflowing the outBuffer.
  72.     
  73.     If Translate() determines that an overflow will occur, it
  74.     will stop the translation at a word boundary before the
  75.     overflow happens.  If this occurs, rtnCode will be a
  76.     negative number whose absolute value indicates where in
  77.     inString Translate() stopped.  The user can then use the
  78.     offset-rtnCode from the beginning of inString in a
  79.     subsequent Translate() call to continue the translation.
  80.  
  81.     SEE ALSO
  82.     narrator.device/CMD_WRITE
  83.  
  84. translator.library/SetAccent                    translator.library/SetAccent
  85.  
  86.     NAME
  87.     Translate -- Set the accent to be used with Translate(). (V42)
  88.     
  89.     SYNOPSIS
  90.     rtnCode = SetAccent(STRPTR accent)
  91.     D0                  A0
  92.  
  93.     BOOL SetAccent(accent)
  94.  
  95.     FUNCTION
  96.     Specify the default Accent file to be used by the Translate()
  97.     function. Either the pathname or just the accent name may be
  98.     specified. In the latter case LOCALE:Accents/ is searched.
  99.     This only affects the current instance of the OpenLibrary. To affect
  100.     further instances ENV:Sys/Translator.prefs needs to be changed.
  101.     
  102.     INPUTS
  103.     accent - name or path of a accent file
  104.     
  105.     RESULTS
  106.     Boolean success of failure.
  107.  
  108. translator.library/LoadAccent                 translator.library/LoadAccent
  109.  
  110.     NAME
  111.     LoadAccent -- (Re)load an accent file into the cache. (V42)
  112.     
  113.     SYNOPSIS
  114.     rtnCode = LoadAccent(accent)
  115.     D0                   A0
  116.  
  117.     BOOL LoadAccent(STRPTR accent)
  118.  
  119.     FUNCTION
  120.     The narrator library maintains a cache of loaded accent files.
  121.     This cache is flushed on low memory situations. This function
  122.     loads (and possible replaces an existing entry) an accent file.
  123.     
  124.     INPUTS
  125.     accent - name or path of a accent file
  126.     
  127.     RESULTS
  128.     Boolean success of failure.
  129.  
  130.